home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / lib / c / hash / Hash_EnumFirst.c < prev    next >
Encoding:
C/C++ Source or Header  |  1988-06-20  |  1.6 KB  |  53 lines
  1. /* 
  2.  * Hash_EnumFirst.c --
  3.  *
  4.  *    Source code for the Hash_EnumFirst library procedure.
  5.  *
  6.  * Copyright 1988 Regents of the University of California
  7.  * Permission to use, copy, modify, and distribute this
  8.  * software and its documentation for any purpose and without
  9.  * fee is hereby granted, provided that the above copyright
  10.  * notice appear in all copies.  The University of California
  11.  * makes no representations about the suitability of this
  12.  * software for any purpose.  It is provided "as is" without
  13.  * express or implied warranty.
  14.  */
  15.  
  16. #ifndef lint
  17. static char rcsid[] = "$Header: Hash_EnumFirst.c,v 1.1 88/06/20 09:30:23 ouster Exp $ SPRITE (Berkeley)";
  18. #endif not lint
  19.  
  20. #include "hash.h"
  21. #include "list.h"
  22.  
  23. /*
  24.  *---------------------------------------------------------
  25.  *
  26.  * Hash_EnumFirst --
  27.  *    This procedure sets things up for a complete search
  28.  *    of all entries recorded in the hash table.
  29.  *
  30.  * Results:    
  31.  *    The return value is the address of the first entry in
  32.  *    the hash table, or NULL if the table is empty.
  33.  *
  34.  * Side Effects:
  35.  *    The information in hashSearchPtr is initialized so that successive
  36.  *    calls to Hash_Next will return successive HashEntry's
  37.  *    from the table.
  38.  *
  39.  *---------------------------------------------------------
  40.  */
  41.  
  42. Hash_Entry *
  43. Hash_EnumFirst(tablePtr, hashSearchPtr)
  44.     Hash_Table *tablePtr;            /* Table to be searched. */
  45.     register Hash_Search *hashSearchPtr;    /* Area in which to keep state 
  46.                          * about search.*/
  47. {
  48.     hashSearchPtr->tablePtr = tablePtr;
  49.     hashSearchPtr->nextIndex = 0;
  50.     hashSearchPtr->hashEntryPtr = (Hash_Entry *) NULL;
  51.     return Hash_EnumNext(hashSearchPtr);
  52. }
  53.